Get Document
AutomatR.DocuSign.Activities.GetDocument
The "Get Document" activity in AutomatR is part of the DocuSign Document activities package, allowing users to download a specific document from a DocuSign envelope. This activity simplifies the process of retrieving individual documents associated with an envelope for further processing within automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Document ID | Enter the Document ID of the specific document within the envelope that you want to download. This field supports only Strings or String variables. |
| Download Directory | Enter the file path of the directory where the downloaded document should be saved. This field supports only Strings or String variables. Example: "C:\Path\To\Your\Download\Directory\" |
| Envelope ID | Enter the Envelope ID from which the document needs to be downloaded. This field supports only Strings or String variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Document" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the full path with the file name of the downloaded document. Variables of data type string to store the path. |
How to use:
- Drag and drop the "Get Document" activity onto the workflow.
- Configure the properties by specifying the Envelope ID, Document ID, and Download Directory.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to download the specified document from the DocuSign envelope.
Important Note:
- Ensure that the "Get Document" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Get Document" activity is used to download a specific document (Document ID: "doc123") from an envelope (Envelope ID: "env456") and save it to the directory "C:\DownloadedDocuments":
Get Document:
Delay: 5
Envelope ID: "env456"
Document ID: "doc123"
Download Directory: "C:\DownloadedDocuments"
Response: documentPath
In this example, the activity downloads the document with Document ID "doc123" from the envelope with ID "env456" and saves it to the directory "C:\DownloadedDocuments." The full path of the downloaded document is stored in the variable "documentPath" for further handling in the workflow.